Inside Macintosh: QuickTime /

Chapter 2 - Movie Toolbox / Movie Toolbox Reference

Functions That Modify Movie Properties / Working With Movie Spatial Characteristics

SetMovieClipRgn

The SetMovieClipRgn function allows your application to establish a movie's clipping region.

pascal void SetMovieClipRgn (Movie theMovie, RgnHandle theClip);

theMovie

Specifies the movie for this operation. Your application obtains this movie identifier from such functions as NewMovie, NewMovieFromFile, and NewMovieFromHandle (described on page 2-80, page 2-76, and page 2-78, respectively).

theClip

Contains a handle to the movie's clipping region. Note that the Movie Toolbox makes a copy of this region. Your application must dispose of the region referred to by this parameter when you are done with it. Set this parameter to nil to disable clipping for the movie.

DESCRIPTION

The clipping region defines any clipping that is applied to the movie before it is mapped to its graphics world by applying the movie's matrix. The clipping region is in the movie's display coordinate system.

The clipping region is saved with the movie.

ERROR CODES

invalidMovie

-2010

This movie is corrupted or invalid

Memory Manager errors

SEE ALSO

You can retrieve the clipping region by calling the GetMovieClipRgn function, which is described in the next section.